home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / editor / insrttxt.lha / rexxutil.doc < prev    next >
Text File  |  1990-09-14  |  5KB  |  206 lines
  1.                               rexxutil.library
  2.                       BETA version 33.159, 14-Sept-90
  3.                          Written by David N. Junod
  4.  
  5. SCOPE
  6.  
  7. This library's goal in life is to add standard data sharing techniques to
  8. ARexx.  It achieves this by providing clipboard access, environment
  9. variables, and temporary files.
  10.  
  11. This library honors both simple and complex variables.
  12.  
  13. This library requires the presence of iffparse.library, and will operate
  14. under version 1.3 or 2.0 of the Amiga operating system.
  15.  
  16.  
  17. FUNCTION SYNOPSIS
  18.  
  19. Clipboard Access
  20.  
  21. The rexxutil.library provides the following functions for clipboard access.
  22.  
  23.   WriteClip    Write information into the desired clipboard unit.
  24.  
  25.   ReadClip    Read the desired clipboard unit into a variable.
  26.  
  27.   QueryClip    Determine the status of any particular clipboard unit.
  28.  
  29.  
  30. Environment Variables
  31.  
  32. The library provides the following environment variable functions.  Note
  33. that under AmigaOS 2.0 the library honors local, as well as global,
  34. variables.
  35.  
  36.   GetVar    Get the value of an environment variable.
  37.  
  38.   SetVar    Set the value of an environment variable.
  39.  
  40.   DeleteVar    Delete an environment variable.
  41.  
  42.  
  43. Temporary Files
  44.  
  45. The library provides the following functions for temporary data.
  46.  
  47.   TmpFile    Provide a temporary file name, guaranteed to be unique.
  48.  
  49.  
  50. FUNCTION DESCRIPTIONS
  51.  
  52. WriteClip(var,vartype,cliptype,unit,author,project)
  53.  
  54.   var        The name of the variable to extract the information from.
  55.  
  56.   vartype    STEM to indicate that var is a complex variable.  Note that
  57.         when using a stem variable, that var MUST end with a period.
  58.         The stem variable must use node 0 to represent the number
  59.         of lines present.  The node clipid is updated to reflect
  60.         the Clip ID assigned to the write.
  61.  
  62.            clip.0 = 1
  63.            clip.1 = "Now is the time"
  64.  
  65.            CALL WriteClip(clip.,STEM)
  66.  
  67.         VAR to indicate that var is a simple variable.  This is the
  68.         default.
  69.  
  70.            clip = "Now is the time"
  71.  
  72.            CALL WriteClip(clip)
  73.  
  74.   cliptype    Use FTXT to indicate that the contents of var are to be
  75.         written as FTXT (text).  FTXT is the default.
  76.  
  77.   unit        A number, ranging from 0 to 255, used to indicate the
  78.         clipboard unit to write the information to.  0 is the
  79.         default.
  80.  
  81.   author    The base name of the application writing the clip.
  82.  
  83.   project    The name of the project that the information was extracted
  84.         from.
  85.  
  86.  
  87. ReadClip(var,vartype,cliptype,unit,author,project)
  88.  
  89.   var        The name of the variable to place the information in.  This
  90.         is only used when vartype is STEM.
  91.  
  92.   vartype    STEM to indicate that var is a complex variable.  Note that
  93.         when using a stem variable, that var MUST end with a period.
  94.  
  95.            CALL ReadClip(clip.,STEM)
  96.  
  97.         When using a stem variable, then the following nodes are
  98.         also filled in.
  99.  
  100.            clipid    Clip ID assigned to the clip.
  101.  
  102.            form        Type of clip (FTXT for text).
  103.  
  104.            auth        Base name of the application that originally
  105.                 wrote the clip.
  106.  
  107.            name        Name of the project that the clip was
  108.                 extracted from.
  109.  
  110.            characters    Indicate the number of characters (only
  111.                 valid when contents are text.
  112.  
  113.            0        Indicate the number of lines.  Then nodes
  114.                 1 to the value of 0 contain the lines of
  115.                 information in the clip.
  116.  
  117.  
  118.         VAR to indicate that the contents are to be returned as a
  119.         simple variable.  This is the default.
  120.  
  121.            clip = ReadClip()
  122.  
  123.   cliptype    Use FTXT to indicate that the contents of var are to be
  124.         written as FTXT (text).  FTXT is the default.
  125.  
  126.   unit        A number, ranging from 0 to 255, used to indicate the
  127.         clipboard unit to write the information to.  0 is the
  128.         default.
  129.  
  130.   author    The base name of the application writing the clip.
  131.  
  132.   project    The name of the project that the information was extracted
  133.         from.
  134.  
  135.  
  136. QueryClip(var,vartype,unit)
  137.  
  138.   var        The name of the variable to place the information in.  This
  139.         is only used when vartype is STEM.
  140.  
  141.   vartype    STEM to indicate that var is a complex variable.  Note that
  142.         when using a stem variable, that var MUST end with a period.
  143.  
  144.            CALL QueryClip(status.,STEM)
  145.  
  146.         When using a stem variable, then the following nodes are
  147.         also filled in.
  148.  
  149.            clipid    Clip ID assigned to the clip.
  150.  
  151.            form        Type of clip (FTXT for text).
  152.  
  153.         VAR to indicate that the contents are to be returned as a
  154.         simple variable.  This is the default.
  155.  
  156.            status = QueryClip()
  157.  
  158.         Where the contents of status are in the form:
  159.  
  160.            clipid, form
  161.  
  162.   unit        A number, ranging from 0 to 255, used to indicate the
  163.         clipboard unit to write the information to.  0 is the
  164.         default.
  165.  
  166.  
  167. GetVar(name,type)
  168.  
  169.   name        Name of the variable to get.
  170.  
  171.   type        GLOBAL, the default, is used to indicate a global
  172.         environment variable.
  173.  
  174.         LOCAL to indicate that the variable is local.
  175.  
  176.  
  177. SetVar(name,value,type)
  178.  
  179.   name        Name of the variable to set.
  180.  
  181.   value        Value to set the variable to.
  182.  
  183.   type        GLOBAL, the default, is used to indicate a global
  184.         environment variable.
  185.  
  186.         LOCAL to indicate a local variable.
  187.  
  188.  
  189. DeleteVar(name,type)
  190.  
  191.   name        Name of the variable to delete.
  192.  
  193.   type        GLOBAL, the default, is used to indicate a global
  194.         environment variable.
  195.  
  196.         LOCAL to indicate a local variable.
  197.  
  198.  
  199. TmpFile(basename)
  200.  
  201.   basename    The base name to use when deriving a unique file name.
  202.         This function will actually attempt to create what is
  203.         supposes to be a unique name, before returning the name to
  204.         the application.  This guarantees that the temporary file
  205.         name is actually unique and capable of being written to.
  206.